Gets the default label setting associated with an icon suite.

SInt16 GetSuiteLabel (
    IconSuiteRef theSuite
);

theSuite

A handle to an icon suite.

function result

The default label setting associated with the specified icon suite. The default label setting is an integer from 1 to 7 that specifies which of the label colors shown in the Finder’s Label menu is applied to icons of that suite when your application displays them. The function returns 0 if the suite doesn’t have a label.

You can override the default label setting for a suite by specifying a label in the transform parameter of the PlotIconSuite function

To get information about the color and string for a specific label, you can use the GetLabel function.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. For that reason, your application should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/18/2000)